<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit - Firmware API: osc.h Source File</title>
<link href="mt_doxygen.css" rel="stylesheet" type="text/css" />
<link href="../resources/mt_doxytabs.css" rel="stylesheet" type="text/css" />
<style type="text/css">
<!--
.header {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 12pt;
	color: #222222;
}
-->
</style>
</head>

<body>
<table width="800" border="0">
    <tr>
      <td colspan="3">
        <form method="get" action="http://www.google.com/search">
          <div align="right">
            <input type="text"   name="q" size="25"
              maxlength="255" value="" />
            <input type="submit" value="Search" />
            <input type="hidden" name="sitesearch" value="makingthings.com/ref/firmware/html" />
          </div>
        </form>
       </td>
    </tr>
    <tr>
      <td><div align="center"><a href="http://www.makingthings.com">
				<img src="../resources/logo_brown_medium.png" alt="MakingThings"
									width="200" height="78" border="0" align="middle" longdesc="http://www.makingthings.com" /></a></div></td>
				<td><div align="center" class="header">
      		Make Controller Kit <br />
          Firmware API
      </div></td>
      <td><div align="center"><a href="http://www.makezine.com">
					<img src="../resources/make_logo.png" alt="MAKE Zine" 
										width="164" height="73" border="0" align="middle" longdesc="http://www.makezine.com" /></a></div></td>
    </tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.5.4 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
  var num=this.id.replace(/[^[0-9]/g,'');
  var button=this.firstChild;
  var sectionDiv=document.getElementById('dynsection'+num);
  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
    sectionDiv.style.display='block';
    button.src='open.gif';
  }else{
    sectionDiv.style.display='none';
    button.src='closed.gif';
  }
}
function initDynSections(){
  var divs=document.getElementsByTagName('div');
  var sectionCounter=1;
  for(var i=0;i<divs.length-1;i++){
    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
      var header=divs[i];
      var section=divs[i+1];
      var button=header.firstChild;
      if (button!='IMG'){
        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
        button=document.createElement('img');
        divs[i].insertBefore(button,divs[i].firstChild);
      }
      header.style.cursor='pointer';
      header.onclick=changeDisplayState;
      header.id='dynheader'+sectionCounter;
      button.src='closed.gif';
      section.id='dynsection'+sectionCounter;
      section.style.display='none';
      section.style.marginLeft='14px';
      sectionCounter++;
    }
  }
}
window.onload = initDynSections;
-->
</script>
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>osc.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*********************************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2006 MakingThings</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Licensed under the Apache License, </span>
<a name="l00006"></a>00006 <span class="comment"> Version 2.0 (the "License"); you may not use this file except in compliance </span>
<a name="l00007"></a>00007 <span class="comment"> with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0 </span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> Unless required by applicable law or agreed to in writing, software distributed</span>
<a name="l00012"></a>00012 <span class="comment"> under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR</span>
<a name="l00013"></a>00013 <span class="comment"> CONDITIONS OF ANY KIND, either express or implied. See the License for</span>
<a name="l00014"></a>00014 <span class="comment"> the specific language governing permissions and limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">*********************************************************************************/</span>
<a name="l00017"></a>00017 
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment">  osc.h</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#include "types.h"</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef OSC_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define OSC_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#define OSC_SUBSYSTEM_COUNT  17</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#define OSC_SCRATCH_SIZE    100</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#define OSC_CHANNEL_COUNT    3</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define OSC_CHANNEL_UDP 0</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="preprocessor">#define OSC_CHANNEL_USB 1</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define OSC_CHANNEL_TCP 2</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="comment">// Top level functions</span>
<a name="l00037"></a>00037 <span class="keywordtype">void</span> Osc_SetActive( <span class="keywordtype">int</span> state );
<a name="l00038"></a>00038 <span class="keywordtype">int</span> Osc_GetActive( <span class="keywordtype">void</span> );
<a name="l00039"></a>00039 <span class="keywordtype">int</span> Osc_GetRunning( <span class="keywordtype">void</span> );
<a name="l00040"></a>00040 
<a name="l00041"></a>00041 <span class="keywordtype">int</span> Osc_CreateMessage( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, ... );
<a name="l00042"></a>00042 <span class="keywordtype">int</span> Osc_CreateMessageToBuf( <span class="keywordtype">char</span>* bp, <span class="keywordtype">int</span>* length, <span class="keywordtype">char</span>* address, <span class="keywordtype">char</span>* format, ... );
<a name="l00043"></a>00043 <span class="keywordtype">int</span> Osc_SendPacket( <span class="keywordtype">int</span> channel );
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g75a7ad99079437eb1b12ea25752540af" title="Register your subsystem with the OSC system.">Osc_RegisterSubsystem</a>( <span class="keyword">const</span> <span class="keywordtype">char</span> *name, 
<a name="l00046"></a>00046                            <span class="keywordtype">int</span> (*Subsystem_ReceiveMessage)( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* buffer, <span class="keywordtype">int</span> length ), 
<a name="l00047"></a>00047                            <span class="keywordtype">int</span> (*Subsystem_Poll)( <span class="keywordtype">int</span> channel ) );
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <span class="comment">// Helpers for processing messages - they return error codes as spec'ed above</span>
<a name="l00050"></a>00050 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g9331ca23d8e81ba91c4e728f0470627e" title="Receive an integer for a subsystem with no indexes.">Osc_IntReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00051"></a>00051                            <span class="keywordtype">char</span>* subsystemName,
<a name="l00052"></a>00052                            <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value ),
<a name="l00053"></a>00053                            <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> property ),
<a name="l00054"></a>00054                            <span class="keywordtype">char</span>* propertyNames[] );
<a name="l00055"></a>00055 
<a name="l00056"></a>00056 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gdaa5a3868eeedcf785c3d52f6b36ef34" title="Receive integers for a subsystem with multiple indexes.">Osc_IndexIntReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00057"></a>00057                                 <span class="keywordtype">int</span> indexCount, <span class="keywordtype">char</span>* subsystemName,
<a name="l00058"></a>00058                                 <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> value ),
<a name="l00059"></a>00059                                 <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property ),
<a name="l00060"></a>00060                                 <span class="keywordtype">char</span>* propertyNames[] );
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g52a8d83512751817b3a4f9f123495fb0" title="Receive an OSC blob for a subsystem with no indexes.">Osc_BlobReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00063"></a>00063                             <span class="keywordtype">char</span>* subsystemName, 
<a name="l00064"></a>00064                             <span class="keywordtype">int</span> (*blobPropertySet)( <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> length ),
<a name="l00065"></a>00065                             <span class="keywordtype">int</span> (*blobPropertyGet)( <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> size ),
<a name="l00066"></a>00066                             <span class="keywordtype">char</span>* blobPropertyNames[] );
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gd6d4ee5a60624c22a31e0b59e560326c" title="Receive an OSC blob for a subsystem with indexes.">Osc_IndexBlobReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00070"></a>00070                                  <span class="keywordtype">int</span> indexCount, <span class="keywordtype">char</span>* subsystemName, 
<a name="l00071"></a>00071                                  <span class="keywordtype">int</span> (*blobPropertySet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> length ),
<a name="l00072"></a>00072                                  <span class="keywordtype">int</span> (*blobPropertyGet)( <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> property, uchar* buffer, <span class="keywordtype">int</span> size ),
<a name="l00073"></a>00073                                  <span class="keywordtype">char</span>* blobPropertyNames[] );
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#gbb24f5e4a4c94eef2c321020941c45b3" title="Receive data for a subsystem that receives a variety of different data types.">Osc_GeneralReceiverHelper</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length, 
<a name="l00076"></a>00076                            <span class="keywordtype">char</span>* subsystemName, 
<a name="l00077"></a>00077                            <span class="keywordtype">int</span> (*propertySet)( <span class="keywordtype">int</span> property, <span class="keywordtype">char</span>* typedata, <span class="keywordtype">int</span> channel ),
<a name="l00078"></a>00078                            <span class="keywordtype">int</span> (*propertyGet)( <span class="keywordtype">int</span> property, <span class="keywordtype">int</span> channel ),
<a name="l00079"></a>00079                            <span class="keywordtype">char</span>* propertyNames[] );
<a name="l00080"></a>00080 
<a name="l00081"></a>00081 <span class="keywordtype">int</span> Osc_SendError( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* subsystemName, <span class="keywordtype">int</span> error );
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 <span class="comment">// Functions needed to process messages</span>
<a name="l00085"></a>00085 <span class="keywordtype">int</span> <a class="code" href="group___o_s_c_a_p_i.html#g852200f3d0612d90d73e9f233392ec2d" title="Send an error back via OSC from your subsystem.">Osc_SubsystemError</a>( <span class="keywordtype">int</span> channel, <span class="keywordtype">char</span>* subsystem, <span class="keywordtype">char</span>* <span class="keywordtype">string</span> );
<a name="l00086"></a>00086 <span class="keywordtype">int</span> Osc_PropertyLookup( <span class="keywordtype">char</span>** properties, <span class="keywordtype">char</span>* property );
<a name="l00087"></a>00087 <span class="keywordtype">char</span> *Osc_FindDataTag( <span class="keywordtype">char</span>* message, <span class="keywordtype">int</span> length );
<a name="l00088"></a>00088 <span class="keywordtype">int</span> Osc_ExtractData( <span class="keywordtype">char</span>* buffer, <span class="keywordtype">char</span>* format, ... );
<a name="l00089"></a>00089 <span class="keywordtype">int</span> Osc_NumberMatch( <span class="keywordtype">int</span> max, <span class="keywordtype">char</span>* pattern, <span class="keywordtype">int</span>* fancy );
<a name="l00090"></a>00090 
<a name="l00091"></a>00091 <span class="comment">// Pattern Match Stuff</span>
<a name="l00092"></a>00092 <span class="keywordtype">bool</span> Osc_PatternMatch(<span class="keyword">const</span> <span class="keywordtype">char</span> *  pattern, <span class="keyword">const</span> <span class="keywordtype">char</span> * test);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> Osc_TcpTask( <span class="keywordtype">void</span> *p );
<a name="l00094"></a>00094 <span class="keywordtype">void</span> Osc_StartTcpTask( <span class="keywordtype">void</span> );
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="preprocessor">#endif</span>
</pre></div><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Make Controller Kit</title>
<style type="text/css">
<!--
.footer {
	font-family: Verdana, Arial, Helvetica, sans-serif;
	font-size: 9pt;
	color: #999999;
}
-->
</style>
</head>

<body>
<hr size="1">
<div>
  <p class="footer">The Make Controller Kit is an open source project maintained by <a href="http://www.makingthings.com">MakingThings</a>.<br />
    MakingThings code is released under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">Apache 2.0 license</a>.<br />
    Bug tracker, development wiki and status can be found at <a href="http://dev.makingthings.com">http://dev.makingthings.com</a>.<br />
		This document was last updated on 5 Dec 2007.
</p>
</div>
<!-- Google Analytics Code -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-769030-1";
urchinTracker();
</script>
</body>
</html>
